Add workspace pkg for managing local configuration #44
Conversation
kohidave
requested review from
efekarakus,
hencrice,
sonofachamp and
a team
pkg/workspace/service.go
Outdated
| } | ||
|
|
||
| func (ws *Service) manifestDirectoryPath() (string, error) { | ||
| if ws.manifestDir != "" { |
There was a problem hiding this comment.
nit: can we add a comment here saying that we're caching the manifest dir path to avoid repeating system calls?
There was a problem hiding this comment.
I wonder if it's better to call this function in the constructor and then have all the other functions just refer to ws.manifestDir? this way we won't have to do the additional error check in the other functions
There was a problem hiding this comment.
Hm, that's not a bad idea. sure!
There was a problem hiding this comment.
Actually, that might be a little tough because of the create case, when we expect there to not be a root directory yet =/
pkg/workspace/workspace.go
Outdated
|
|
||
| // If there isn't an existing workspace summary, create it. | ||
| var noProjectFound *ErrNoProjectAssociated | ||
| if errors.As(existingWorkspaceSummaryErr, &noProjectFound) { |
pkg/archer/workspace.go
Outdated
| } | ||
|
|
||
| // ManifestManager can read, write and list local manifest files. | ||
| type ManifestManager interface { |
There was a problem hiding this comment.
Could this interface be simplified to:
type Manifest interface {
Write([]byte, string) error
Read(string) ([]byte, error)
List() ([]string, error)
}Manager seems implicit via the API.
pkg/workspace/errors.go
Outdated
| @@ -0,0 +1,43 @@ | |||
| package workspace | |||
There was a problem hiding this comment.
missing Copyright lines
pkg/workspace/workspace_test.go
Outdated
| @@ -0,0 +1,379 @@ | |||
| package workspace | |||
Adding a new package for easy reading and writing of local workspace level configuration. This includes: 1. Reading and Writing manifest files 2. Reading and Writing a project breadcrumb file The project breadcrumb is used to store the project name (and in the future perhaps the pipeline in charge of this workspace).
Adding a new package for easy reading and writing of local
workspace level configuration.
This includes:
The workspace summary is used to store the project name
(and in the future perhaps the pipeline in charge of this
workspace).